<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>EasySSLProtocolSocketFactory xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../../../../../apidocs/org/sakaiproject/entitybus/util/http/EasySSLProtocolSocketFactory.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="comment">/*</em>
<a name="2" href="#2">2</a>   <em class="comment"> * $HeadURL: http://entitybus.googlecode.com/svn/maven/site/entitybus-utils/xref/org/sakaiproject/entitybus/util/http/EasySSLProtocolSocketFactory.html $</em>
<a name="3" href="#3">3</a>   <em class="comment"> * $Revision: 12 $</em>
<a name="4" href="#4">4</a>   <em class="comment"> * $Date: 2009-01-29 12:00:24 +0000 (Thu, 29 Jan 2009) $</em>
<a name="5" href="#5">5</a>   <em class="comment"> * </em>
<a name="6" href="#6">6</a>   <em class="comment"> * ====================================================================</em>
<a name="7" href="#7">7</a>   <em class="comment"> *</em>
<a name="8" href="#8">8</a>   <em class="comment"> *  Licensed to the Apache Software Foundation (ASF) under one or more</em>
<a name="9" href="#9">9</a>   <em class="comment"> *  contributor license agreements.  See the NOTICE file distributed with</em>
<a name="10" href="#10">10</a>  <em class="comment"> *  this work for additional information regarding copyright ownership.</em>
<a name="11" href="#11">11</a>  <em class="comment"> *  The ASF licenses this file to You under the Apache License, Version 2.0</em>
<a name="12" href="#12">12</a>  <em class="comment"> *  (the "License"); you may not use this file except in compliance with</em>
<a name="13" href="#13">13</a>  <em class="comment"> *  the License.  You may obtain a copy of the License at</em>
<a name="14" href="#14">14</a>  <em class="comment"> *</em>
<a name="15" href="#15">15</a>  <em class="comment"> *      <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="16" href="#16">16</a>  <em class="comment"> *</em>
<a name="17" href="#17">17</a>  <em class="comment"> *  Unless required by applicable law or agreed to in writing, software</em>
<a name="18" href="#18">18</a>  <em class="comment"> *  distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="19" href="#19">19</a>  <em class="comment"> *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="20" href="#20">20</a>  <em class="comment"> *  See the License for the specific language governing permissions and</em>
<a name="21" href="#21">21</a>  <em class="comment"> *  limitations under the License.</em>
<a name="22" href="#22">22</a>  <em class="comment"> * ====================================================================</em>
<a name="23" href="#23">23</a>  <em class="comment"> *</em>
<a name="24" href="#24">24</a>  <em class="comment"> * This software consists of voluntary contributions made by many</em>
<a name="25" href="#25">25</a>  <em class="comment"> * individuals on behalf of the Apache Software Foundation.  For more</em>
<a name="26" href="#26">26</a>  <em class="comment"> * information on the Apache Software Foundation, please see</em>
<a name="27" href="#27">27</a>  <em class="comment"> * &lt;<a href="http://www.apache.org/" target="alexandria_uri">http://www.apache.org/</a>>.</em>
<a name="28" href="#28">28</a>  <em class="comment"> *</em>
<a name="29" href="#29">29</a>  <em class="comment"> */</em>
<a name="30" href="#30">30</a>  
<a name="31" href="#31">31</a>  <strong>package</strong> org.sakaiproject.entitybus.util.http;
<a name="32" href="#32">32</a>  
<a name="33" href="#33">33</a>  <strong>import</strong> java.io.IOException;
<a name="34" href="#34">34</a>  <strong>import</strong> java.net.InetAddress;
<a name="35" href="#35">35</a>  <strong>import</strong> java.net.InetSocketAddress;
<a name="36" href="#36">36</a>  <strong>import</strong> java.net.Socket;
<a name="37" href="#37">37</a>  <strong>import</strong> java.net.SocketAddress;
<a name="38" href="#38">38</a>  <strong>import</strong> java.net.UnknownHostException;
<a name="39" href="#39">39</a>  
<a name="40" href="#40">40</a>  <strong>import</strong> javax.net.SocketFactory;
<a name="41" href="#41">41</a>  <strong>import</strong> javax.net.ssl.SSLContext;
<a name="42" href="#42">42</a>  <strong>import</strong> javax.net.ssl.TrustManager;
<a name="43" href="#43">43</a>  
<a name="44" href="#44">44</a>  <strong>import</strong> org.apache.commons.httpclient.ConnectTimeoutException;
<a name="45" href="#45">45</a>  <strong>import</strong> org.apache.commons.httpclient.HttpClientError;
<a name="46" href="#46">46</a>  <strong>import</strong> org.apache.commons.httpclient.params.HttpConnectionParams;
<a name="47" href="#47">47</a>  <strong>import</strong> org.apache.commons.httpclient.protocol.SecureProtocolSocketFactory;
<a name="48" href="#48">48</a>  <strong>import</strong> org.apache.commons.logging.Log;
<a name="49" href="#49">49</a>  <strong>import</strong> org.apache.commons.logging.LogFactory;
<a name="50" href="#50">50</a>  
<a name="51" href="#51">51</a>  <em>/**<em>*</em></em>
<a name="52" href="#52">52</a>  <em> * &lt;p></em>
<a name="53" href="#53">53</a>  <em> * EasySSLProtocolSocketFactory can be used to creats SSL {@link Socket}s </em>
<a name="54" href="#54">54</a>  <em> * that accept self-signed certificates. </em>
<a name="55" href="#55">55</a>  <em> * &lt;/p></em>
<a name="56" href="#56">56</a>  <em> * &lt;p></em>
<a name="57" href="#57">57</a>  <em> * This socket factory SHOULD NOT be used for productive systems </em>
<a name="58" href="#58">58</a>  <em> * due to security reasons, unless it is a concious decision and </em>
<a name="59" href="#59">59</a>  <em> * you are perfectly aware of security implications of accepting </em>
<a name="60" href="#60">60</a>  <em> * self-signed certificates</em>
<a name="61" href="#61">61</a>  <em> * &lt;/p></em>
<a name="62" href="#62">62</a>  <em> *</em>
<a name="63" href="#63">63</a>  <em> * &lt;p></em>
<a name="64" href="#64">64</a>  <em> * Example of using custom protocol socket factory for a specific host:</em>
<a name="65" href="#65">65</a>  <em> *     &lt;pre></em>
<a name="66" href="#66">66</a>  <em> *     Protocol easyhttps = new Protocol("https", new EasySSLProtocolSocketFactory(), 443);</em>
<a name="67" href="#67">67</a>  <em> *</em>
<a name="68" href="#68">68</a>  <em> *     URI uri = new URI("https://localhost/", true);</em>
<a name="69" href="#69">69</a>  <em> *     // use relative url only</em>
<a name="70" href="#70">70</a>  <em> *     GetMethod httpget = new GetMethod(uri.getPathQuery());</em>
<a name="71" href="#71">71</a>  <em> *     HostConfiguration hc = new HostConfiguration();</em>
<a name="72" href="#72">72</a>  <em> *     hc.setHost(uri.getHost(), uri.getPort(), easyhttps);</em>
<a name="73" href="#73">73</a>  <em> *     HttpClient client = new HttpClient();</em>
<a name="74" href="#74">74</a>  <em> *     client.executeMethod(hc, httpget);</em>
<a name="75" href="#75">75</a>  <em> *     &lt;/pre></em>
<a name="76" href="#76">76</a>  <em> * &lt;/p></em>
<a name="77" href="#77">77</a>  <em> * &lt;p></em>
<a name="78" href="#78">78</a>  <em> * Example of using custom protocol socket factory per default instead of the standard one:</em>
<a name="79" href="#79">79</a>  <em> *     &lt;pre></em>
<a name="80" href="#80">80</a>  <em> *     Protocol easyhttps = new Protocol("https", new EasySSLProtocolSocketFactory(), 443);</em>
<a name="81" href="#81">81</a>  <em> *     Protocol.registerProtocol("https", easyhttps);</em>
<a name="82" href="#82">82</a>  <em> *</em>
<a name="83" href="#83">83</a>  <em> *     HttpClient client = new HttpClient();</em>
<a name="84" href="#84">84</a>  <em> *     GetMethod httpget = new GetMethod("https://localhost/");</em>
<a name="85" href="#85">85</a>  <em> *     client.executeMethod(httpget);</em>
<a name="86" href="#86">86</a>  <em> *     &lt;/pre></em>
<a name="87" href="#87">87</a>  <em> * &lt;/p></em>
<a name="88" href="#88">88</a>  <em> * </em>
<a name="89" href="#89">89</a>  <em> * @author &lt;a href="<a href="mailto:oleg" target="alexandria_uri">mailto:oleg</a> -at- ural.ru">Oleg Kalnichevski&lt;/a></em>
<a name="90" href="#90">90</a>  <em> * </em>
<a name="91" href="#91">91</a>  <em> * &lt;p></em>
<a name="92" href="#92">92</a>  <em> * DISCLAIMER: HttpClient developers DO NOT actively support this component.</em>
<a name="93" href="#93">93</a>  <em> * The component is provided as a reference material, which may be inappropriate</em>
<a name="94" href="#94">94</a>  <em> * for use without additional customization.</em>
<a name="95" href="#95">95</a>  <em> * &lt;/p></em>
<a name="96" href="#96">96</a>  <em> */</em>
<a name="97" href="#97">97</a>  
<a name="98" href="#98">98</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../../org/sakaiproject/entitybus/util/http/EasySSLProtocolSocketFactory.html">EasySSLProtocolSocketFactory</a> implements SecureProtocolSocketFactory {
<a name="99" href="#99">99</a>  
<a name="100" href="#100">100</a>     <em>/**<em>* Log object for this class. */</em></em>
<a name="101" href="#101">101</a>     <strong>private</strong> <strong>static</strong> <strong>final</strong> Log LOG = LogFactory.getLog(EasySSLProtocolSocketFactory.<strong>class</strong>);
<a name="102" href="#102">102</a> 
<a name="103" href="#103">103</a>     <strong>private</strong> SSLContext sslcontext = <strong>null</strong>;
<a name="104" href="#104">104</a> 
<a name="105" href="#105">105</a>     <em>/**<em>*</em></em>
<a name="106" href="#106">106</a> <em>     * Constructor for EasySSLProtocolSocketFactory.</em>
<a name="107" href="#107">107</a> <em>     */</em>
<a name="108" href="#108">108</a>     <strong>public</strong> <a href="../../../../../org/sakaiproject/entitybus/util/http/EasySSLProtocolSocketFactory.html">EasySSLProtocolSocketFactory</a>() {
<a name="109" href="#109">109</a>         <strong>super</strong>();
<a name="110" href="#110">110</a>     }
<a name="111" href="#111">111</a> 
<a name="112" href="#112">112</a>     <strong>private</strong> <strong>static</strong> SSLContext createEasySSLContext() {
<a name="113" href="#113">113</a>         <strong>try</strong> {
<a name="114" href="#114">114</a>             SSLContext context = SSLContext.getInstance(<span class="string">"SSL"</span>);
<a name="115" href="#115">115</a>             context.init(
<a name="116" href="#116">116</a>               <strong>null</strong>, 
<a name="117" href="#117">117</a>               <strong>new</strong> TrustManager[] {<strong>new</strong> EasyX509TrustManager(<strong>null</strong>)}, 
<a name="118" href="#118">118</a>               <strong>null</strong>);
<a name="119" href="#119">119</a>             <strong>return</strong> context;
<a name="120" href="#120">120</a>         } <strong>catch</strong> (Exception e) {
<a name="121" href="#121">121</a>             LOG.error(e.getMessage(), e);
<a name="122" href="#122">122</a>             <strong>throw</strong> <strong>new</strong> HttpClientError(e.toString());
<a name="123" href="#123">123</a>         }
<a name="124" href="#124">124</a>     }
<a name="125" href="#125">125</a> 
<a name="126" href="#126">126</a>     <strong>private</strong> SSLContext getSSLContext() {
<a name="127" href="#127">127</a>         <strong>if</strong> (<strong>this</strong>.sslcontext == <strong>null</strong>) {
<a name="128" href="#128">128</a>             <strong>this</strong>.sslcontext = createEasySSLContext();
<a name="129" href="#129">129</a>         }
<a name="130" href="#130">130</a>         <strong>return</strong> <strong>this</strong>.sslcontext;
<a name="131" href="#131">131</a>     }
<a name="132" href="#132">132</a> 
<a name="133" href="#133">133</a>     <em>/**<em>*</em></em>
<a name="134" href="#134">134</a> <em>     * @see SecureProtocolSocketFactory#createSocket(java.lang.String,int,java.net.InetAddress,int)</em>
<a name="135" href="#135">135</a> <em>     */</em>
<a name="136" href="#136">136</a>     <strong>public</strong> Socket createSocket(
<a name="137" href="#137">137</a>         String host,
<a name="138" href="#138">138</a>         <strong>int</strong> port,
<a name="139" href="#139">139</a>         InetAddress clientHost,
<a name="140" href="#140">140</a>         <strong>int</strong> clientPort)
<a name="141" href="#141">141</a>         throws IOException, UnknownHostException {
<a name="142" href="#142">142</a> 
<a name="143" href="#143">143</a>         <strong>return</strong> getSSLContext().getSocketFactory().createSocket(
<a name="144" href="#144">144</a>             host,
<a name="145" href="#145">145</a>             port,
<a name="146" href="#146">146</a>             clientHost,
<a name="147" href="#147">147</a>             clientPort
<a name="148" href="#148">148</a>         );
<a name="149" href="#149">149</a>     }
<a name="150" href="#150">150</a> 
<a name="151" href="#151">151</a>     <em>/**<em>*</em></em>
<a name="152" href="#152">152</a> <em>     * Attempts to get a new socket connection to the given host within the given time limit.</em>
<a name="153" href="#153">153</a> <em>     * &lt;p></em>
<a name="154" href="#154">154</a> <em>     * To circumvent the limitations of older JREs that do not support connect timeout a </em>
<a name="155" href="#155">155</a> <em>     * controller thread is executed. The controller thread attempts to create a new socket </em>
<a name="156" href="#156">156</a> <em>     * within the given limit of time. If socket constructor does not return until the </em>
<a name="157" href="#157">157</a> <em>     * timeout expires, the controller terminates and throws an {@link ConnectTimeoutException}</em>
<a name="158" href="#158">158</a> <em>     * &lt;/p></em>
<a name="159" href="#159">159</a> <em>     *  </em>
<a name="160" href="#160">160</a> <em>     * @param host the host name/IP</em>
<a name="161" href="#161">161</a> <em>     * @param port the port on the host</em>
<a name="162" href="#162">162</a> <em>     * @param clientHost the local host name/IP to bind the socket to</em>
<a name="163" href="#163">163</a> <em>     * @param clientPort the port on the local machine</em>
<a name="164" href="#164">164</a> <em>     * @param params {@link HttpConnectionParams Http connection parameters}</em>
<a name="165" href="#165">165</a> <em>     * </em>
<a name="166" href="#166">166</a> <em>     * @return Socket a new socket</em>
<a name="167" href="#167">167</a> <em>     * </em>
<a name="168" href="#168">168</a> <em>     * @throws IOException if an I/O error occurs while creating the socket</em>
<a name="169" href="#169">169</a> <em>     * @throws UnknownHostException if the IP address of the host cannot be</em>
<a name="170" href="#170">170</a> <em>     * determined</em>
<a name="171" href="#171">171</a> <em>     */</em>
<a name="172" href="#172">172</a>     <strong>public</strong> Socket createSocket(
<a name="173" href="#173">173</a>         <strong>final</strong> String host,
<a name="174" href="#174">174</a>         <strong>final</strong> <strong>int</strong> port,
<a name="175" href="#175">175</a>         <strong>final</strong> InetAddress localAddress,
<a name="176" href="#176">176</a>         <strong>final</strong> <strong>int</strong> localPort,
<a name="177" href="#177">177</a>         <strong>final</strong> HttpConnectionParams params
<a name="178" href="#178">178</a>     ) throws IOException, UnknownHostException, ConnectTimeoutException {
<a name="179" href="#179">179</a>         <strong>if</strong> (params == <strong>null</strong>) {
<a name="180" href="#180">180</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Parameters may not be null"</span>);
<a name="181" href="#181">181</a>         }
<a name="182" href="#182">182</a>         <strong>int</strong> timeout = params.getConnectionTimeout();
<a name="183" href="#183">183</a>         SocketFactory socketfactory = getSSLContext().getSocketFactory();
<a name="184" href="#184">184</a>         <strong>if</strong> (timeout == 0) {
<a name="185" href="#185">185</a>             <strong>return</strong> socketfactory.createSocket(host, port, localAddress, localPort);
<a name="186" href="#186">186</a>         } <strong>else</strong> {
<a name="187" href="#187">187</a>             Socket socket = socketfactory.createSocket();
<a name="188" href="#188">188</a>             SocketAddress localaddr = <strong>new</strong> InetSocketAddress(localAddress, localPort);
<a name="189" href="#189">189</a>             SocketAddress remoteaddr = <strong>new</strong> InetSocketAddress(host, port);
<a name="190" href="#190">190</a>             socket.bind(localaddr);
<a name="191" href="#191">191</a>             socket.connect(remoteaddr, timeout);
<a name="192" href="#192">192</a>             <strong>return</strong> socket;
<a name="193" href="#193">193</a>         }
<a name="194" href="#194">194</a>     }
<a name="195" href="#195">195</a> 
<a name="196" href="#196">196</a>     <em>/**<em>*</em></em>
<a name="197" href="#197">197</a> <em>     * @see SecureProtocolSocketFactory#createSocket(java.lang.String,int)</em>
<a name="198" href="#198">198</a> <em>     */</em>
<a name="199" href="#199">199</a>     <strong>public</strong> Socket createSocket(String host, <strong>int</strong> port)
<a name="200" href="#200">200</a>         throws IOException, UnknownHostException {
<a name="201" href="#201">201</a>         <strong>return</strong> getSSLContext().getSocketFactory().createSocket(
<a name="202" href="#202">202</a>             host,
<a name="203" href="#203">203</a>             port
<a name="204" href="#204">204</a>         );
<a name="205" href="#205">205</a>     }
<a name="206" href="#206">206</a> 
<a name="207" href="#207">207</a>     <em>/**<em>*</em></em>
<a name="208" href="#208">208</a> <em>     * @see SecureProtocolSocketFactory#createSocket(java.net.Socket,java.lang.String,int,boolean)</em>
<a name="209" href="#209">209</a> <em>     */</em>
<a name="210" href="#210">210</a>     <strong>public</strong> Socket createSocket(
<a name="211" href="#211">211</a>         Socket socket,
<a name="212" href="#212">212</a>         String host,
<a name="213" href="#213">213</a>         <strong>int</strong> port,
<a name="214" href="#214">214</a>         <strong>boolean</strong> autoClose)
<a name="215" href="#215">215</a>         throws IOException, UnknownHostException {
<a name="216" href="#216">216</a>         <strong>return</strong> getSSLContext().getSocketFactory().createSocket(
<a name="217" href="#217">217</a>             socket,
<a name="218" href="#218">218</a>             host,
<a name="219" href="#219">219</a>             port,
<a name="220" href="#220">220</a>             autoClose
<a name="221" href="#221">221</a>         );
<a name="222" href="#222">222</a>     }
<a name="223" href="#223">223</a> 
<a name="224" href="#224">224</a>     <strong>public</strong> <strong>boolean</strong> equals(Object obj) {
<a name="225" href="#225">225</a>         <strong>return</strong> ((obj != <strong>null</strong>) &amp;&amp; obj.getClass().equals(<strong>this</strong>.getClass()));
<a name="226" href="#226">226</a>     }
<a name="227" href="#227">227</a> 
<a name="228" href="#228">228</a>     <strong>public</strong> <strong>int</strong> hashCode() {
<a name="229" href="#229">229</a>         <strong>return</strong> EasySSLProtocolSocketFactory.<strong>class</strong>.hashCode();
<a name="230" href="#230">230</a>     }
<a name="231" href="#231">231</a> 
<a name="232" href="#232">232</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

